home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / src / Tools / less-252 / ch.c < prev    next >
Encoding:
C/C++ Source or Header  |  1995-05-11  |  15.2 KB  |  739 lines
  1. /*
  2.  * Copyright (c) 1984,1985,1989,1994  Mark Nudelman
  3.  * All rights reserved.
  4.  *
  5.  * Redistribution and use in source and binary forms, with or without
  6.  * modification, are permitted provided that the following conditions
  7.  * are met:
  8.  * 1. Redistributions of source code must retain the above copyright
  9.  *    notice, this list of conditions and the following disclaimer.
  10.  * 2. Redistributions in binary form must reproduce the above copyright
  11.  *    notice in the documentation and/or other materials provided with 
  12.  *    the distribution.
  13.  *
  14.  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
  15.  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16.  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 
  17.  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE
  18.  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
  19.  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 
  20.  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR 
  21.  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
  22.  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 
  23.  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN 
  24.  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25.  */
  26.  
  27.  
  28. /*
  29.  * Low level character input from the input file.
  30.  * We use these special purpose routines which optimize moving
  31.  * both forward and backward from the current read pointer.
  32.  */
  33.  
  34. #include "less.h"
  35.  
  36. public int file = -1;        /* File descriptor of the input file */
  37. public int ignore_eoi;
  38.  
  39. /*
  40.  * Pool of buffers holding the most recently used blocks of the input file.
  41.  */
  42. #define LBUFSIZE    1024
  43. struct buf {
  44.     struct buf *next, *prev;  /* Must be first to match struct filestate */
  45.     long block;
  46.     unsigned int datasize;
  47.     unsigned char data[LBUFSIZE];
  48. };
  49.  
  50. /*
  51.  * The buffer pool is kept as a doubly-linked circular list,
  52.  * in order from most- to least-recently used.
  53.  * The circular list is anchored by the file state "thisfile".
  54.  *
  55.  * The file state is maintained in a filestate structure.
  56.  * There are two such structures, one used when input is a pipe
  57.  * and the other when input is an ordinary file.
  58.  * This is so that we can leave a pipe, look and other files,
  59.  * and return to the pipe without losing buffered data.
  60.  * Buffered data can be reconstructed for a non-pipe file by
  61.  * simply re-reading the file, but a pipe cannot be re-read.
  62.  */
  63.  
  64. struct filestate {
  65.     struct buf *next, *prev;   /* Must be first to match struct buf */
  66.     POSITION fpos;
  67.     int nbufs;
  68.     long block;
  69.     int offset;
  70.     POSITION fsize;
  71. };
  72.  
  73. #define    END_OF_CHAIN    ((struct buf *)thisfile)
  74. #define    buf_head    thisfile->next
  75. #define    buf_tail    thisfile->prev
  76. #define    ch_nbufs    thisfile->nbufs
  77. #define    ch_block    thisfile->block
  78. #define    ch_offset    thisfile->offset
  79. #define    ch_fpos        thisfile->fpos
  80. #define    ch_fsize    thisfile->fsize
  81.  
  82. static struct filestate pipefile =
  83.     { (struct buf *)&pipefile, (struct buf *)&pipefile };
  84.  
  85. static struct filestate nonpipefile = 
  86.     { (struct buf *)&nonpipefile, (struct buf *)&nonpipefile };
  87.  
  88. static struct filestate *thisfile;
  89.  
  90. extern int ispipe;
  91. extern int autobuf;
  92. extern int sigs;
  93. #if LOGFILE
  94. extern int logfile;
  95. extern char *namelogfile;
  96. #endif
  97.  
  98. static int ch_addbuf();
  99.  
  100.  
  101. /*
  102.  * Get the character pointed to by the read pointer.
  103.  * ch_get() is a macro which is more efficient to call
  104.  * than fch_get (the function), in the usual case 
  105.  * that the block desired is at the head of the chain.
  106.  */
  107. #define    ch_get()   ((ch_block == buf_head->block && \
  108.              ch_offset < buf_head->datasize) ? \
  109.             buf_head->data[ch_offset] : fch_get())
  110.     int
  111. fch_get()
  112. {
  113.     register struct buf *bp;
  114.     register int n;
  115.     register int slept;
  116.     POSITION pos;
  117.     POSITION len;
  118.  
  119.     slept = 0;
  120.  
  121.     /*
  122.      * Look for a buffer holding the desired block.
  123.      */
  124.     for (bp = buf_head;  bp != END_OF_CHAIN;  bp = bp->next)
  125.         if (bp->block == ch_block)
  126.         {
  127.             if (ch_offset >= bp->datasize)
  128.                 /*
  129.                  * Need more data in this buffer.
  130.                  */
  131.                 goto read_more;
  132.             goto found;
  133.         }
  134.     /*
  135.      * Block is not in a buffer.  
  136.      * Take the least recently used buffer 
  137.      * and read the desired block into it.
  138.      * If the LRU buffer has data in it, 
  139.      * and autobuf is true, and input is a pipe, 
  140.      * then try to allocate a new buffer first.
  141.      */
  142.     if (autobuf && ispipe && buf_tail->block != (long)(-1))
  143.         if (ch_addbuf(1))
  144.             /*
  145.              * Allocation failed: turn off autobuf.
  146.              */
  147.             autobuf = 0;
  148.     bp = buf_tail;
  149.     bp->block = ch_block;
  150.     bp->datasize = 0;
  151.  
  152.     read_more:
  153.     pos = (ch_block * LBUFSIZE) + bp->datasize;
  154.     if ((len = ch_length()) != NULL_POSITION && pos >= len)
  155.         /*
  156.          * At end of file.
  157.          */
  158.         return (EOI);
  159.  
  160.     if (pos != ch_fpos)
  161.     {
  162.         /*
  163.          * Not at the correct position: must seek.
  164.          * If input is a pipe, we're in trouble (can't seek on a pipe).
  165.          * Some data has been lost: just return "?".
  166.          */
  167.         if (ispipe)
  168.             return ('?');
  169.         if (lseek(file, (off_t)pos, 0) == BAD_LSEEK)
  170.         {
  171.              error("seek error", NULL_PARG);
  172.              quit(1);
  173.          }
  174.          ch_fpos = pos;
  175.      }
  176.  
  177.     /*
  178.      * Read the block.
  179.      * If we read less than a full block, that's ok.
  180.      * We use partial block and pick up the rest next time.
  181.      */
  182.     n = iread(file, &bp->data[bp->datasize], 
  183.         (unsigned int)(LBUFSIZE - bp->datasize));
  184.     if (n == READ_INTR)
  185.         return (EOI);
  186.     if (n < 0)
  187.     {
  188.         error("read error", NULL_PARG);
  189.         quit(1);
  190.     }
  191.     ch_fpos += n;
  192.  
  193. #if LOGFILE
  194.     /*
  195.      * If we have a log file, write the new data to it.
  196.      */
  197.     if (logfile >= 0 && n > 0)
  198.         write(logfile, (char *) &bp->data[bp->datasize], n);
  199. #endif
  200.  
  201.     bp->datasize += n;
  202.  
  203.     /*
  204.      * If we have read to end of file, set ch_fsize to indicate
  205.      * the position of the end of file.
  206.      */
  207.     if (n == 0)
  208.     {
  209.         ch_fsize = pos;
  210.         if (ignore_eoi)
  211.         {
  212.             /*
  213.              * We are ignoring EOF.
  214.              * Wait a while, then try again.
  215.              */
  216.             if (!slept)
  217.                 ierror("Waiting for data", NULL_PARG);
  218. #if !MSOFTC
  219.              sleep(1);
  220. #endif
  221.             slept = 1;
  222.         }
  223.         if (ABORT_SIGS())
  224.             return (EOI);
  225.     }
  226.  
  227.     found:
  228.     if (buf_head != bp)
  229.     {
  230.         /*
  231.          * Move the buffer to the head of the buffer chain.
  232.          * This orders the buffer chain, most- to least-recently used.
  233.          */
  234.         bp->next->prev = bp->prev;
  235.         bp->prev->next = bp->next;
  236.  
  237.         bp->next = buf_head;
  238.         bp->prev = END_OF_CHAIN;
  239.         buf_head->prev = bp;
  240.         buf_head = bp;
  241.     }
  242.  
  243.     if (ch_offset >= bp->datasize)
  244.         /*
  245.          * After all that, we still don't have enough data.
  246.          * Go back and try again.
  247.          */
  248.         goto read_more;
  249.  
  250.     return (bp->data[ch_offset]);
  251. }
  252.  
  253. #if LOGFILE
  254. /*
  255.  * Close the logfile.
  256.  * If we haven't read all of standard input into it, do that now.
  257.  */
  258.     public void
  259. end_logfile()
  260. {
  261.     static int tried = 0;
  262.  
  263.     if (logfile < 0)
  264.         return;
  265.     if (!tried && ch_fsize == NULL_POSITION)
  266.     {
  267.         tried = 1;
  268.         ierror("Finishing logfile", NULL_PARG);
  269.         while (ch_forw_get() != EOI)
  270.             if (ABORT_SIGS())
  271.                 break;
  272.     }
  273.     close(logfile);
  274.     logfile = -1;
  275.     namelogfile = NULL;
  276. }
  277.  
  278. /*
  279.  * Start a log file AFTER less has already been running.
  280.  * Invoked from the - command; see toggle_option().
  281.  * Write all the existing buffered data to the log file.
  282.  */
  283.     public void
  284. sync_logfile()
  285. {
  286.     register struct buf *bp;
  287.     long block;
  288.     long last_block;
  289.  
  290.     last_block = (ch_fpos + LBUFSIZE - 1) / LBUFSIZE;
  291.     for (block = 0;  block <= last_block;  block++)
  292.         for (bp = buf_head;  bp != END_OF_CHAIN;  bp = bp->next)
  293.             if (bp->block == block)
  294.             {
  295.                 write(logfile, (char *) bp->data, bp->datasize);
  296.                 break;
  297.             }
  298. }
  299.  
  300. #endif
  301.  
  302. /*
  303.  * Determine if a specific block is currently in one of the buffers.
  304.  */
  305.     static int
  306. buffered(block)
  307.     long block;
  308. {
  309.     register struct buf *bp;
  310.  
  311.     for (bp = buf_head;  bp != END_OF_CHAIN;  bp = bp->next)
  312.         if (bp->block == block)
  313.             return (1);
  314.     return (0);
  315. }
  316.  
  317. /*
  318.  * Seek to a specified position in the file.
  319.  * Return 0 if successful, non-zero if can't seek there.
  320.  */
  321.     public int
  322. ch_seek(pos)
  323.     register POSITION pos;
  324. {
  325.     long new_block;
  326.     POSITION len;
  327.  
  328.     len = ch_length();
  329.     if (pos < ch_zero() || (len != NULL_POSITION && pos > len))
  330.         return (1);
  331.  
  332.     new_block = pos / LBUFSIZE;
  333.     if (ispipe && pos != ch_fpos && !buffered(new_block))
  334.         return (1);
  335.     /*
  336.      * Set read pointer.
  337.      */
  338.     ch_block = new_block;
  339.     ch_offset = pos % LBUFSIZE;
  340.     return (0);
  341. }
  342.  
  343. /*
  344.  * Seek to the end of the file.
  345.  */
  346.     public int
  347. ch_end_seek()
  348. {
  349.     POSITION len;
  350.  
  351.     if (!ispipe)
  352.         ch_fsize = filesize(file);
  353.  
  354.     len = ch_length();
  355.     if (len != NULL_POSITION)
  356.         return (ch_seek(len));
  357.  
  358.     /*
  359.      * Do it the slow way: read till end of data.
  360.      */
  361.     while (ch_forw_get() != EOI)
  362.         if (ABORT_SIGS())
  363.             return (1);
  364.     return (0);
  365. }
  366.  
  367. /*
  368.  * Seek to the beginning of the file, or as close to it as we can get.
  369.  * We may not be able to seek there if input is a pipe and the
  370.  * beginning of the pipe is no longer buffered.
  371.  */
  372.     public int
  373. ch_beg_seek()
  374. {
  375.     register struct buf *bp, *firstbp;
  376.  
  377.     /*
  378.      * Try a plain ch_seek first.
  379.      */
  380.     if (ch_seek(ch_zero()) == 0)
  381.         return (0);
  382.  
  383.     /*
  384.      * Can't get to position 0.
  385.      * Look thru the buffers for the one closest to position 0.
  386.      */
  387.     firstbp = bp = buf_head;
  388.     if (bp == END_OF_CHAIN)
  389.         return (1);
  390.     while ((bp = bp->next) != END_OF_CHAIN)
  391.         if (bp->block < firstbp->block)
  392.             firstbp = bp;
  393.     ch_block = firstbp->block;
  394.     ch_offset = 0;
  395.     return (0);
  396. }
  397.  
  398. /*
  399.  * Return the length of the file, if known.
  400.  */
  401.     public POSITION
  402. ch_length()
  403. {
  404.     if (ignore_eoi)
  405.         return (NULL_POSITION);
  406.     return (ch_fsize);
  407. }
  408.  
  409. /*
  410.  * Return the current position in the file.
  411.  */
  412. #define    tellpos(blk,off)   ((POSITION)((((long)(blk)) * LBUFSIZE) + (off)))
  413.  
  414.     public POSITION
  415. ch_tell()
  416. {
  417.     return (tellpos(ch_block, ch_offset));
  418. }
  419.  
  420. /*
  421.  * Get the current char and post-increment the read pointer.
  422.  */
  423.     public int
  424. ch_forw_get()
  425. {
  426.     register int c;
  427.  
  428.     c = ch_get();
  429.     if (c == EOI)
  430.         return (EOI);
  431.     if (ch_offset < LBUFSIZE-1)
  432.         ch_offset++;
  433.     else
  434.     {
  435. #if __ZOFFSET /* NOT WORKING */
  436.         if (ch_fsize != NULL_POSITION && 
  437.             tellpos(ch_block+1, 0) >= ch_fsize)
  438.             return (EOI);
  439. #endif
  440.         ch_block ++;
  441.         ch_offset = 0;
  442.     }
  443.     return (c);
  444. }
  445.  
  446. /*
  447.  * Pre-decrement the read pointer and get the new current char.
  448.  */
  449.     public int
  450. ch_back_get()
  451. {
  452.     if (ch_offset > 0)
  453.         ch_offset --;
  454.     else
  455.     {
  456. #if __ZOFFSET /* NOT WORKING */
  457.         if (tellpos(ch_block-1, LBUFSIZE-1) < ch_zero())
  458.             return (EOI);
  459. #else
  460.         if (ch_block <= 0)
  461.             return (EOI);
  462. #endif
  463.         if (ispipe && !buffered(ch_block-1))
  464.             return (EOI);
  465.         ch_block--;
  466.         ch_offset = LBUFSIZE-1;
  467.     }
  468.     return (ch_get());
  469. }
  470.  
  471. /*
  472.  * Allocate buffers.
  473.  * Caller wants us to have a total of at least want_nbufs buffers.
  474.  */
  475.     public int
  476. ch_nbuf(want_nbufs)
  477.     int want_nbufs;
  478. {
  479.     PARG parg;
  480.  
  481.     if (ch_nbufs < want_nbufs && ch_addbuf(want_nbufs - ch_nbufs))
  482.     {
  483.         /*
  484.          * Cannot allocate enough buffers.
  485.          * If we don't have ANY, then quit.
  486.          * Otherwise, just report the error and return.
  487.          */
  488.         parg.p_int = want_nbufs - ch_nbufs;
  489.         error("Cannot allocate %d buffers", &parg);
  490.         if (ch_nbufs == 0)
  491.             quit(1);
  492.     }
  493.     return (ch_nbufs);
  494. }
  495.  
  496. /*
  497.  * Flush any saved file state, including buffer contents.
  498.  */
  499.     public void
  500. ch_flush()
  501. {
  502.     register struct buf *bp;
  503.  
  504.     if (ispipe)
  505.     {
  506.         /*
  507.          * If input is a pipe, we don't flush buffer contents,
  508.          * since the contents can't be recovered.
  509.          */
  510.         ch_fsize = NULL_POSITION;
  511.         return;
  512.     }
  513.  
  514.     /*
  515.      * Initialize all the buffers.
  516.      */
  517.     for (bp = buf_head;  bp != END_OF_CHAIN;  bp = bp->next)
  518.         bp->block = (long)(-1);
  519.  
  520.     /*
  521.      * Figure out the size of the file, if we can.
  522.      */
  523.     ch_fsize = filesize(file);
  524.  
  525.     /*
  526.      * Seek to a known position: the beginning of the file.
  527.      */
  528.     ch_fpos = 0;
  529.     ch_block = ch_fpos / LBUFSIZE;
  530.     ch_offset = ch_fpos % LBUFSIZE;
  531.  
  532.     if (lseek(file, (off_t)0, 0) == BAD_LSEEK)
  533.     {
  534.         /*
  535.          * Warning only; even if the seek fails for some reason,
  536.          * there's a good chance we're at the beginning anyway.
  537.          * {{ I think this is bogus reasoning. }}
  538.          */
  539.         error("seek error to 0", NULL_PARG);
  540.     }
  541. }
  542.  
  543. /*
  544.  * Allocate some new buffers.
  545.  * The buffers are added to the tail of the buffer chain.
  546.  */
  547.     static int
  548. ch_addbuf(nnew)
  549.     int nnew;
  550. {
  551.     register struct buf *bp;
  552.     register struct buf *newbufs;
  553.  
  554.     /*
  555.      * We don't have enough buffers.  
  556.      * Allocate some new ones.
  557.      */
  558.     newbufs = (struct buf *) calloc(nnew, sizeof(struct buf));
  559.     if (newbufs == NULL)
  560.         return (1);
  561.  
  562.     /*
  563.      * Initialize the new buffers and link them together.
  564.      * Link them all onto the tail of the buffer list.
  565.      */
  566.     ch_nbufs += nnew;
  567.     for (bp = &newbufs[0];  bp < &newbufs[nnew];  bp++)
  568.     {
  569.         bp->next = bp + 1;
  570.         bp->prev = bp - 1;
  571.         bp->block = (long)(-1);
  572.     }
  573.     newbufs[nnew-1].next = END_OF_CHAIN;
  574.     newbufs[0].prev = buf_tail;
  575.     buf_tail->next = &newbufs[0];
  576.     buf_tail = &newbufs[nnew-1];
  577.     return (0);
  578. }
  579.  
  580. /*
  581.  * Use the pipe file state.
  582.  */
  583.     public void
  584. ch_pipe()
  585. {
  586.     thisfile = &pipefile;
  587. }
  588.  
  589. /*
  590.  * Use the non-pipe file state.
  591.  */
  592.     public void
  593. ch_nonpipe()
  594. {
  595.     thisfile = &nonpipefile;
  596. }
  597.  
  598. #if 0
  599. /* TESTING */
  600.  
  601. extern VOID_POINTER memchr();
  602. extern char linebuf[];
  603. extern int size_linebuf;
  604.  
  605. /*
  606.  * Analogous to forw_line(), but deals with "raw lines":
  607.  * lines which are not split for screen width.
  608.  * {{ This is supposed to be more efficient than forw_line(). }}
  609.  */
  610.     public POSITION
  611. forw_raw_line(curr_pos, linep)
  612.     POSITION curr_pos;
  613.     char **linep;
  614. {
  615.     register char *p;
  616.     register int bc;
  617.     register int avail;
  618.     register int space;
  619.     register char *q;
  620.  
  621.     if (curr_pos == NULL_POSITION || ch_seek(curr_pos) || fch_get() == EOI)
  622.         return (NULL_POSITION);
  623.  
  624.     p = linebuf;
  625.     space = size_linebuf - 1;
  626.  
  627.     do
  628.     {
  629.         /*
  630.          * avail = bytes available in data buffer.
  631.          * space = space left in line buffer.
  632.          * bc    = byte count to move from data buffer to line buffer.
  633.          */
  634.         bc = avail = buf_head->datasize - ch_offset;
  635.         if (avail <= 0)
  636.             break;
  637.         /*
  638.          * Find the next newline in data buffer.
  639.          */
  640.         q = (char *) memchr((char *) &buf_head->data[ch_offset], '\n', avail);
  641.         if (q != NULL)
  642.         {
  643.             /*
  644.              * Found a newline.
  645.              * Copy data buffer to line buffer and we're done.
  646.              */
  647.             bc = q - (char *) &buf_head->data[ch_offset];
  648.             if (bc > space)
  649.                 bc = space;
  650.             memcpy(p, (char *) &buf_head->data[ch_offset], bc);
  651.             p += bc;
  652.             ch_offset += bc + 1;
  653.             if (ch_offset >= LBUFSIZE)
  654.             {
  655.                 ch_offset = 0;
  656.                 ch_block++;
  657.             }
  658.             break;
  659.         } 
  660.         /*
  661.          * Didn't find a newline.
  662.          * Copy data buffer to line buffer,
  663.          * get the next data buffer and try again.
  664.          */
  665.         bc = avail;
  666.         if (bc > space)
  667.             bc = space;
  668.         memcpy(p, (char *) &buf_head->data[ch_offset], bc);
  669.         space -= bc;
  670.         p += bc;
  671.         ch_offset = 0;
  672.         ch_block++; 
  673.     } while (fch_get() != EOI && space > 0);
  674.  
  675.     *p = '\0';
  676.     if (linep != NULL)
  677.         *linep = linebuf;
  678.     return (ch_tell());
  679. }
  680.  
  681. /*
  682.  * Analogous to back_line(), but deals with "raw lines".
  683.  * {{ This is supposed to be more efficient than back_line(). }}
  684.  */
  685.     public POSITION
  686. back_raw_line(curr_pos, linep)
  687.     POSITION curr_pos;
  688.     char **linep;
  689. {
  690.     register char *p;
  691.     register char *q;    /* scratch pointer */
  692.     register i;        /* scratch index */
  693.     register int bc;    /* byte count to transfer */
  694.     register int space;    /* space left in linebuf */
  695.     
  696.     if (curr_pos == NULL_POSITION || curr_pos <= (POSITION)1 ||
  697.         ch_seek(curr_pos-2) || ch_get() == EOI)
  698.         return (NULL_POSITION);
  699.  
  700.     p = &linebuf[size_linebuf];
  701.     *--p = '\0';
  702.     space = size_linebuf - 1;
  703.  
  704.     do {
  705.         bc = ch_offset + 1;
  706.         if (bc > space)
  707.             bc = space;
  708.         /*
  709.          * Find the previous newline in data buffer.
  710.          */
  711.         q = (char *) &buf_head->data[ch_offset] + 1;
  712.         for (i = bc;  i > 0;  i--)
  713.             if ((*--p = *--q) == '\n')
  714.             {
  715.                 /*
  716.                  * Found a newline.
  717.                  * We're done.
  718.                  */
  719.                 p++;
  720.                 ch_offset -= bc - i;
  721.                 ch_seek(ch_tell() + 1);
  722.                 goto done;
  723.             }
  724.         /*
  725.          * Didn't find a newline.
  726.          */
  727.         bc--;
  728.         ch_offset -= bc;
  729.         space -= bc;
  730.     } while (space > 0 && ch_block > 0 && ch_seek(ch_tell() - 1) == 0 && 
  731.          fch_get() != EOI);
  732.  
  733.     done:
  734.     if (linep != NULL)
  735.         *linep = p;
  736.     return (ch_tell());
  737. }
  738. #endif
  739.